Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
Shortage of high-quality data threatening the AI boom
And other fundamental issues highlighted by the Open Data Institute.
Data centres top the list of growth opportunities
In robust, yet heterogenous world BACS market.
Increased funding for BSR announced
Within plans for next generation of new towns.
New Towns Taskforce interim policy statement
With initial reactions to the 6 month policy update.
Heritage, industry and slavery
Interpretation must tell the story accurately.
PM announces Building safety and fire move to MHCLG
Following recommendations of the Grenfell Inquiry report.
Conserving the ruins of a great Elizabethan country house.
BSRIA European air conditioning market update 2024
Highs, lows and discrepancy rates in the annual demand.
50 years celebrating the ECA Apprenticeship Awards
As SMEs say the 10 years of the Apprenticeship Levy has failed them.
Nominations sought for CIOB awards
Celebrating construction excellence in Ireland and Northern Ireland.
EPC consultation in context: NCM, SAP, SBEM and HEM
One week to respond to the consultation on reforms to the Energy Performance of Buildings framework.
CIAT Celebrates 60 years of Architectural Technology
Find out more #CIAT60 social media takeover.
The BPF urges Chancellor for additional BSR resources
To remove barriers and bottlenecks which delay projects.
Flexibility over requirements to boost apprentice numbers
English, maths and minimumun duration requirements reduced for a 10,000 gain.
A long term view on European heating markets
BSRIA HVAC 2032 Study.
Humidity resilience strategies for home design
Frequency of extreme humidity events is increasing.
National Apprenticeship Week 2025
Skills for life : 10-16 February